Skip to main content

Password Reset

User Password Reset

The endpoint below enables you to reset password.

POST /api/v1/auth/password/reset

authorization : bearer token
REQUEST BODY SCHEMA : application/json
username
required
string

Email or phone number of the user

resetCode
required
string >= 6 characters

Reset code sent via email or sms to the user. Use /auth/password/request-reset to request a reset code.

password
required
string [ 5 .. 30 ] characters

New password of the user

passwordConfirm
required
string [ 5 .. 30 ] characters

Confirm new password of the user. Value must match password

{
  • "username": "+233123456789",
  • "resetCode": 123456,
  • "password": "new-password",
  • "passwordConfirm": "new-password"
}


At this point, the user must have received a password reset code via email/sms. The user must follow the steps below. No bearer token is required for this.

  • Input the reset code.

  • Enter the new password.

  • Confirm the new password.

username
required
string

Email or phone number of the user

resetCode
required
string >= 6 characters

Reset code sent via email or sms to the user. Use /auth/password/request-reset to request a reset code.

password
required
string [ 5 .. 30 ] characters

New password of the user

passwordConfirm
required
string [ 5 .. 30 ] characters

Confirm new password of the user. Value must match password

{
  • "username": "+233123456789",
  • "resetCode": 123456,
  • "password": "new-password",
  • "passwordConfirm": "new-password"
}